home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / lib / emacs / 19.22 / lisp / supercite.el < prev    next >
Lisp/Scheme  |  1993-11-22  |  70KB  |  1,989 lines
  1. ;;; supercite.el --- minor mode for citing mail and news replies
  2.  
  3. ;; Author: 1993 Barry A. Warsaw, Century Computing, Inc. <bwarsaw@cen.com>
  4. ;; Maintainer:    supercite-help@anthem.nlm.nih.gov
  5. ;; Created:       February 1993
  6. ;; Version:       3.1
  7. ;; Last Modified: 1993/09/22 18:58:46
  8. ;; Keywords: mail, news
  9.  
  10. ;; supercite.el revision: 3.54
  11.  
  12. ;; Copyright (C) 1993 Barry A. Warsaw
  13.  
  14. ;; This file is part of GNU Emacs.
  15.  
  16. ;; GNU Emacs is free software; you can redistribute it and/or modify
  17. ;; it under the terms of the GNU General Public License as published by
  18. ;; the Free Software Foundation; either version 2, or (at your option)
  19. ;; any later version.
  20.  
  21. ;; GNU Emacs is distributed in the hope that it will be useful,
  22. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  23. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24. ;; GNU General Public License for more details.
  25.  
  26. ;; You should have received a copy of the GNU General Public License
  27. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  28. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  29.  
  30. ;; LCD Archive Entry
  31. ;; supercite|Barry A. Warsaw|supercite-help@anthem.nlm.nih.gov
  32. ;; |Mail and news reply citation package
  33. ;; |1993/09/22 18:58:46|3.1|
  34.  
  35. ;; Code:
  36.  
  37.  
  38. (require 'regi)
  39.  
  40. ;; start user configuration variables
  41. ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
  42.  
  43. (defvar sc-auto-fill-region-p t
  44.   "*If non-nil, automatically fill each paragraph after it has been cited.")
  45.  
  46. (defvar sc-blank-lines-after-headers 1
  47.   "*Number of blank lines to leave after mail headers have been nuked.
  48. Set to nil, to use whatever blank lines happen to occur naturally.")
  49.  
  50. (defvar sc-citation-leader "    "
  51.   "*String comprising first part of a citation.")
  52. (defvar sc-citation-delimiter ">"
  53.   "*String comprising third part of a citation.
  54. This string is used in both nested and non-nested citations.")
  55. (defvar sc-citation-separator " "
  56.   "*String comprising fourth and last part of a citation.")
  57.  
  58. (defvar sc-citation-leader-regexp "[ \t]*"
  59.   "*Regexp describing citation leader for a cited line.
  60. This should NOT have a leading `^' character.")
  61.  
  62. ;; Nemacs and Mule users note: please see the texinfo manual for
  63. ;; suggestions on setting these variables.
  64. (defvar sc-citation-root-regexp "[-._a-zA-Z0-9]*"
  65.   "*Regexp describing variable root part of a citation for a cited line.
  66. This should NOT have a leading `^' character.  See also
  67. `sc-citation-nonnested-root-regexp'.")
  68. (defvar sc-citation-nonnested-root-regexp "[-._a-zA-Z0-9]+"
  69.   "*Regexp describing the variable root part of a nested citation.
  70. This should NOT have a leading `^' character.  This variable is
  71. related to `sc-citation-root-regexp' but where as that varariable
  72. describes both nested and non-nested citation roots, this variable
  73. describes only nested citation roots.")
  74. (defvar sc-citation-delimiter-regexp "[>]+"
  75.   "*Regexp describing citation delimiter for a cited line.
  76. This should NOT have a leading `^' character.")
  77. (defvar sc-citation-separator-regexp "[ \t]*"
  78.   "*Regexp describing citation separator for a cited line.
  79. This should NOT have a leading `^' character.")
  80.  
  81. (defvar sc-cite-blank-lines-p nil
  82.   "*If non-nil, put a citation on blank lines.")
  83.  
  84. (defvar sc-cite-frame-alist '()
  85.   "*Alist for frame selection during citing.
  86. Each element of this list has the following form:
  87.  
  88.    (INFOKEY ((REGEXP . FRAME)
  89.              (REGEXP . FRAME)
  90.              (...)))
  91.  
  92. Where INFOKEY is a key for `sc-mail-field', REGEXP is a regular
  93. expression to match against the INFOKEY's value.  FRAME is a citation
  94. frame, or a variable containing a citation frame.")
  95. (defvar sc-uncite-frame-alist '()
  96.   "*Alist for frame selection during unciting.
  97. See the variable `sc-cite-frame-alist' for details.")
  98. (defvar sc-recite-frame-alist '()
  99.   "*Alist for frame selection during reciting.
  100. See the variable `sc-cite-frame-alist' for details.")
  101.  
  102. (defvar sc-default-cite-frame
  103.   '(;; initialize fill state and temporary variables when entering
  104.     ;; frame. this makes things run much faster
  105.     (begin (progn
  106.          (sc-fill-if-different)
  107.          (setq sc-tmp-nested-regexp (sc-cite-regexp "")
  108.            sc-tmp-nonnested-regexp (sc-cite-regexp)
  109.            sc-tmp-dumb-regexp
  110.            (concat "\\("
  111.                (sc-cite-regexp "")
  112.                "\\)"
  113.                (sc-cite-regexp sc-citation-nonnested-root-regexp))
  114.            )))
  115.     ;; blank lines mean paragraph separators, so fill the last cited
  116.     ;; paragraph, unless sc-cite-blank-lines-p is non-nil, in which
  117.     ;; case we treat blank lines just like any other line.
  118.     ("^[ \t]*$"                 (if sc-cite-blank-lines-p
  119.                     (sc-cite-line)
  120.                   (sc-fill-if-different "")))
  121.     ;; do nothing if looking at a reference tag. make sure that the
  122.     ;; tag string isn't the empty string since this will match every
  123.     ;; line.  it cannot be nil.
  124.     (sc-reference-tag-string    (if (string= sc-reference-tag-string "")
  125.                     (list 'continue)
  126.                   nil))
  127.     ;; this regexp catches nested citations in which the author cited
  128.     ;; a non-nested citation with a dumb citer.
  129.     (sc-tmp-dumb-regexp         (sc-cite-coerce-dumb-citer))
  130.     ;; if we are looking at a nested citation then add a citation level
  131.     (sc-tmp-nested-regexp       (sc-add-citation-level))
  132.     ;; if we're looking at a non-nested citation, coerce it to our style
  133.     (sc-tmp-nonnested-regexp    (sc-cite-coerce-cited-line))
  134.     ;; we must be looking at an uncited line. if we are in nested
  135.     ;; citations, just add a citation level
  136.     (sc-nested-citation-p       (sc-add-citation-level))
  137.     ;; we're looking at an uncited line and we are in non-nested
  138.     ;; citations, so cite it with a non-nested citation
  139.     (t                          (sc-cite-line))
  140.     ;; be sure when we're done that we fill the last cited paragraph.
  141.     (end                        (sc-fill-if-different ""))
  142.     )
  143.   "*Default REGI frame for citing a region.")
  144.  
  145. (defvar sc-default-uncite-frame
  146.   '(;; do nothing on a blank line
  147.     ("^[ \t]*$"       nil)
  148.     ;; if the line is cited, uncite it
  149.     ((sc-cite-regexp) (sc-uncite-line))
  150.     )
  151.   "*Default REGI frame for unciting a region.")
  152.  
  153. (defvar sc-default-recite-frame
  154.   '(;; initialize fill state when entering frame
  155.     (begin            (sc-fill-if-different))
  156.     ;; do nothing on a blank line
  157.     ("^[ \t]*$"       nil)
  158.     ;; if we're looking at a cited line, recite it
  159.     ((sc-cite-regexp) (sc-recite-line (sc-cite-regexp)))
  160.     ;; otherwise, the line is uncited, so just cite it
  161.     (t                (sc-cite-line))
  162.     ;; be sure when we're done that we fill the last cited paragraph.
  163.     (end              (sc-fill-if-different ""))
  164.     )
  165.   "*Default REGI frame for reciting a region.")
  166.  
  167. (defvar sc-cite-region-limit t
  168.   "*This variable controls automatic citation of yanked text.
  169. Legal values are:
  170.  
  171. non-nil   -- cite the entire region, regardless of its size
  172. nil       -- do not cite the region at all
  173. <integer> -- a number indicating the threshold for citation.  When
  174.          the number of lines in the region is greater than this
  175.          value, a warning message will be printed and the region
  176.          will not be cited.  Lines in region are counted with
  177.          `count-lines'. 
  178.  
  179. The gathering of attribution information is not affected by the value
  180. of this variable.  The number of lines in the region is calculated
  181. *after* all mail headers are removed.  This variable is only consulted
  182. during the initial citing via `sc-cite-original'.")
  183.  
  184. (defvar sc-confirm-always-p t
  185.   "*If non-nil, always confirm attribution string before citing text body.")
  186.  
  187. (defvar sc-default-attribution "Anon"
  188.   "*String used when author's attribution cannot be determined.")
  189. (defvar sc-default-author-name "Anonymous"
  190.   "*String used when author's name cannot be determined.")
  191.  
  192. (defvar sc-downcase-p nil
  193.   "*Non-nil means downcase the attribution and citation strings.")
  194.  
  195. (defvar sc-electric-circular-p t
  196.   "*If non-nil, treat electric references as circular.")
  197. (defvar sc-electric-mode-hook nil
  198.   "*Hook for `sc-electric-mode' electric references mode.")
  199. (defvar sc-electric-references-p nil
  200.   "*Use electric references if non-nil.")
  201.  
  202. (defvar sc-fixup-whitespace-p nil
  203.   "*If non-nil, delete all leading white space before citing.")
  204.  
  205. (defvar sc-load-hook nil
  206.   "*Hook which gets run once after Supercite loads.")
  207. (defvar sc-pre-hook nil
  208.   "*Hook which gets run before each invocation of `sc-cite-original'.")
  209. (defvar sc-post-hook nil
  210.   "*Hook which gets run after each invocation of `sc-cite-original'.")
  211.  
  212. (defvar sc-mail-warn-if-non-rfc822-p t
  213.   "*Warn if mail headers don't conform to RFC822.")
  214. (defvar sc-mumble ""
  215.   "*Value returned by `sc-mail-field' if field isn't in mail headers.")
  216.  
  217. (defvar sc-name-filter-alist
  218.   '(("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" . 0)
  219.     ("^\\(Jr\\|Sr\\)[.]?$" . last)
  220.     ("^ASTS$" . 0)
  221.     ("^[I]+$" . last))
  222.   "*Name list components which are filtered out as noise.
  223. This variable contains an association list where each element is of
  224. the form:  (REGEXP . POSITION).
  225.  
  226. REGEXP is a regular expression which matches the name list component.
  227. Match is performed using `string-match'.  POSITION is the position in
  228. the name list which can match the regular expression, starting at zero
  229. for the first element.  Use `last' to match the last element in the
  230. list and `any' to match all elements.")
  231.  
  232. (defvar sc-nested-citation-p nil
  233.   "*Controls whether to use nested or non-nested citation style.
  234. Non-nil uses nested citations, nil uses non-nested citations.")
  235.  
  236. (defvar sc-nuke-mail-headers 'all
  237.   "*Controls mail header nuking.
  238. Used in conjunction with `sc-nuke-mail-header-list'.  Legal values are:
  239.  
  240. `all'       -- nuke all mail headers
  241. `none'      -- don't nuke any mail headers
  242. `specified' -- nuke headers specified in `sc-nuke-mail-header-list'
  243. `keep'      -- keep headers specified in `sc-nuke-mail-header-list'")
  244.  
  245. (defvar sc-nuke-mail-header-list nil
  246.   "*List of mail header regexps to remove or keep in body of reply.
  247. This list contains regular expressions describing the mail headers to
  248. keep or nuke, depending on the value of `sc-nuke-mail-headers'.")
  249.  
  250. (defvar sc-preferred-attribution-list
  251.   '("sc-lastchoice" "x-attribution" "firstname" "initials" "lastname")
  252.   "*Specifies what to use as the attribution string.
  253. Supercite creates a list of possible attributions when it scans the
  254. mail headers from the original message.  Each attribution choice is
  255. associated with a key in an attribution alist.  Supercite tries to
  256. pick a \"preferred\" attribution by matching the attribution alist
  257. keys against the elements in `sc-preferred-attribution-list' in order.
  258. The first non-empty string value found is used as the preferred
  259. attribution.
  260.  
  261. Note that Supercite now honors the X-Attribution: mail field.  If
  262. present in the original message, the value of this field should always
  263. be used to select the most preferred attribution since it reflects how
  264. the original author would like to be distinguished.  It should be
  265. considered bad taste to put any attribution preference key before
  266. \"x-attribution\" in this list, except perhaps for \"sc-lastchoice\"
  267. (see below).
  268.  
  269. Supercite remembers the last attribution used when reciting an already
  270. cited paragraph.  This attribution will always be saved with the
  271. \"sc-lastchoice\" key, which can be used in this list.  Note that the
  272. last choice is always reset after every call of `sc-cite-original'.
  273.  
  274. Barring error conditions, the following preferences are always present
  275. in the attribution alist:
  276.  
  277. \"emailname\"    -- email terminus name
  278. \"initials\"     -- initials of author
  279. \"firstname\"    -- first name of author
  280. \"lastname\"     -- last name of author
  281. \"middlename-1\" -- first middle name of author
  282. \"middlename-2\" -- second middle name of author
  283. ...
  284.  
  285. Middle name indexes can be any positive integer greater than 0,
  286. although it is unlikely that many authors will supply more than one
  287. middle name, if that many.  The string of all middle names is
  288. associated with the key \"middlenames\".")
  289.  
  290. (defvar sc-attrib-selection-list nil
  291.   "*An alist for selecting preferred attribution based on mail headers.
  292. Each element of this list has the following form:
  293.  
  294.    (INFOKEY ((REGEXP . ATTRIBUTION)
  295.              (REGEXP . ATTRIBUTION)
  296.              (...)))
  297.  
  298. Where INFOKEY is a key for `sc-mail-field', REGEXP is a regular
  299. expression to match against the INFOKEY's value. ATTRIBUTION can be a
  300. string or a list.  If its a string, then it is the attribution that is
  301. selected by `sc-select-attribution'.  If it is a list, it is `eval'd
  302. and the return value must be a string, which is used as the selected
  303. attribution.  Note that the variable `sc-preferred-attribution-list'
  304. must contain an element of the string \"sc-consult\" for this variable
  305. to be consulted during attribution selection.")
  306.  
  307. (defvar sc-attribs-preselect-hook nil
  308.   "*Hook to run before selecting an attribution.")
  309. (defvar sc-attribs-postselect-hook nil
  310.   "*Hook to run after selecting an attribution, but before confirmation.")
  311.  
  312. (defvar sc-pre-cite-hook nil
  313.   "*Hook to run before citing a region of text.")
  314. (defvar sc-pre-uncite-hook nil
  315.   "*Hook to run before unciting a region of text.")
  316. (defvar sc-pre-recite-hook nil
  317.   "*Hook to run before reciting a region of text.")
  318.  
  319. (defvar sc-preferred-header-style 4
  320.   "*Index into `sc-rewrite-header-list' specifying preferred header style.
  321. Index zero accesses the first function in the list.")
  322.  
  323. (defvar sc-reference-tag-string ">>>>> "
  324.   "*String used at the beginning of built-in reference headers.")
  325.  
  326. (defvar sc-rewrite-header-list
  327.   '((sc-no-header)
  328.     (sc-header-on-said)
  329.     (sc-header-inarticle-writes)
  330.     (sc-header-regarding-adds)
  331.     (sc-header-attributed-writes)
  332.     (sc-header-author-writes)
  333.     (sc-header-verbose)
  334.     (sc-no-blank-line-or-header)
  335.     )
  336.   "*List of reference header rewrite functions.
  337. The variable `sc-preferred-header-style' controls which function in
  338. this list is chosen for automatic reference header insertions.
  339. Electric reference mode will cycle through this list of functions.")
  340.  
  341. (defvar sc-titlecue-regexp "\\s +-+\\s +"
  342.   "*Regular expression describing the separator between names and titles.
  343. Set to nil to treat entire field as a name.")
  344.  
  345. (defvar sc-use-only-preference-p nil
  346.   "*Controls what happens when the preferred attribution cannot be found.
  347. If non-nil, then `sc-default-attribution' will be used.  If nil, then
  348. some secondary scheme will be employed to find a suitable attribution
  349. string.")
  350.  
  351. ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  352. ;; end user configuration variables
  353.  
  354. (defconst sc-version "3.1"
  355.   "Supercite version number.")
  356. (defconst sc-help-address "supercite-help@anthem.nlm.nih.gov"
  357.   "Address accepting submissions of bug reports.")
  358.  
  359. (defvar sc-mail-info nil
  360.   "Alist of mail header information gleaned from reply buffer.")
  361. (defvar sc-attributions nil
  362.   "Alist of attributions for use when citing.")
  363.  
  364. (defconst sc-emacs-features
  365.   (let ((version 'v18)
  366.     (flavor  'GNU))
  367.     (if (string= (substring emacs-version 0 2) "19")
  368.     (setq version 'v19))
  369.     (if (string-match "Lucid" emacs-version)
  370.     (setq flavor 'Lucid))
  371.     ;; cobble up list
  372.     (list version flavor))
  373.   "A list describing what version of Emacs we're running on.
  374. Known flavors are:
  375.  
  376. All GNU18's: (v18 GNU)
  377. FSF19.x    : (v19 GNU)
  378. Lucid19.x  : (v19 Lucid)")
  379.  
  380.  
  381. (defvar sc-tmp-nested-regexp nil
  382.   "Temporary regepx describing nested citations.")
  383. (defvar sc-tmp-nonnested-regexp nil
  384.   "Temporary regexp describing non-nested citations.")
  385. (defvar sc-tmp-dumb-regexp nil
  386.   "Temp regexp describing non-nested citation cited with a nesting citer.")
  387.  
  388. (defvar sc-minor-mode nil
  389.   "Supercite minor mode on flag.")
  390. (defvar sc-mode-string " SC"
  391.   "Supercite minor mode string.")
  392.  
  393. (make-variable-buffer-local 'sc-mail-info)
  394. (make-variable-buffer-local 'sc-attributions)
  395. (make-variable-buffer-local 'sc-minor-mode)
  396.  
  397.  
  398. ;; ======================================================================
  399. ;; supercite keymaps
  400.  
  401. (defvar sc-mode-map-prefix "\C-c\C-p"
  402.   "*Key binding to install Supercite keymap.
  403. If this is nil, Supercite keymap is not installed.")
  404.  
  405. (defvar sc-T-keymap ()
  406.   "Keymap for sub-keymap of setting and toggling functions.")
  407. (if sc-T-keymap
  408.     ()
  409.   (setq sc-T-keymap (make-sparse-keymap))
  410.   (define-key sc-T-keymap "a" 'sc-S-preferred-attribution-list)
  411.   (define-key sc-T-keymap "b" 'sc-T-mail-nuke-blank-lines)
  412.   (define-key sc-T-keymap "c" 'sc-T-confirm-always)
  413.   (define-key sc-T-keymap "d" 'sc-T-downcase)
  414.   (define-key sc-T-keymap "e" 'sc-T-electric-references)
  415.   (define-key sc-T-keymap "f" 'sc-T-auto-fill-region)
  416.   (define-key sc-T-keymap "h" 'sc-T-describe)
  417.   (define-key sc-T-keymap "l" 'sc-S-cite-region-limit)
  418.   (define-key sc-T-keymap "n" 'sc-S-mail-nuke-mail-headers)
  419.   (define-key sc-T-keymap "N" 'sc-S-mail-header-nuke-list)
  420.   (define-key sc-T-keymap "o" 'sc-T-electric-circular)
  421.   (define-key sc-T-keymap "p" 'sc-S-preferred-header-style)
  422.   (define-key sc-T-keymap "s" 'sc-T-nested-citation)
  423.   (define-key sc-T-keymap "u" 'sc-T-use-only-preferences)
  424.   (define-key sc-T-keymap "w" 'sc-T-fixup-whitespace)
  425.   (define-key sc-T-keymap "?" 'sc-T-describe)
  426.   )
  427.  
  428. (defvar sc-mode-map ()
  429.   "Keymap for Supercite quasi-mode.")
  430. (if sc-mode-map
  431.     ()
  432.   (setq sc-mode-map (make-sparse-keymap))
  433.   (define-key sc-mode-map "c"    'sc-cite-region)
  434.   (define-key sc-mode-map "f"    'sc-mail-field-query)
  435.   (define-key sc-mode-map "g"    'sc-mail-process-headers)
  436.   (define-key sc-mode-map "h"    'sc-describe)
  437.   (define-key sc-mode-map "i"    'sc-insert-citation)
  438.   (define-key sc-mode-map "o"    'sc-open-line)
  439.   (define-key sc-mode-map "r"    'sc-recite-region)
  440.   (define-key sc-mode-map "\C-p" 'sc-raw-mode-toggle)
  441.   (define-key sc-mode-map "u"    'sc-uncite-region)
  442.   (define-key sc-mode-map "v"    'sc-version)
  443.   (define-key sc-mode-map "w"    'sc-insert-reference)
  444.   (define-key sc-mode-map "\C-t"  sc-T-keymap)
  445.   (define-key sc-mode-map "\C-b" 'sc-submit-bug-report)
  446.   (define-key sc-mode-map "?"    'sc-describe)
  447.   )
  448.   
  449. (defvar sc-electric-mode-map ()
  450.   "Keymap for `sc-electric-mode' electric references mode.")
  451. (if sc-electric-mode-map
  452.     nil
  453.   (setq sc-electric-mode-map (make-sparse-keymap))
  454.   (define-key sc-electric-mode-map "p"    'sc-eref-prev)
  455.   (define-key sc-electric-mode-map "n"    'sc-eref-next)
  456.   (define-key sc-electric-mode-map "s"    'sc-eref-setn)
  457.   (define-key sc-electric-mode-map "j"    'sc-eref-jump)
  458.   (define-key sc-electric-mode-map "x"    'sc-eref-abort)
  459.   (define-key sc-electric-mode-map "q"    'sc-eref-abort)
  460.   (define-key sc-electric-mode-map "\r"   'sc-eref-exit)
  461.   (define-key sc-electric-mode-map "\n"   'sc-eref-exit)
  462.   (define-key sc-electric-mode-map "g"    'sc-eref-goto)
  463.   (define-key sc-electric-mode-map "?"    'describe-mode)
  464.   (define-key sc-electric-mode-map "\C-h" 'describe-mode)
  465.   )
  466.  
  467. (defvar sc-minibuffer-local-completion-map nil
  468.   "Keymap for minibuffer confirmation of attribution strings.")
  469. (if sc-minibuffer-local-completion-map
  470.     ()
  471.   (setq sc-minibuffer-local-completion-map
  472.     (copy-keymap minibuffer-local-completion-map))
  473.   (define-key sc-minibuffer-local-completion-map "\C-t" 'sc-toggle-fn)
  474.   (define-key sc-minibuffer-local-completion-map " "    'self-insert-command))
  475.  
  476. (defvar sc-minibuffer-local-map nil
  477.   "Keymap for minibuffer confirmation of attribution strings.")
  478. (if sc-minibuffer-local-map
  479.     ()
  480.   (setq sc-minibuffer-local-map (copy-keymap minibuffer-local-map))
  481.   (define-key sc-minibuffer-local-map "\C-t" 'sc-toggle-fn))
  482.  
  483.  
  484. ;; ======================================================================
  485. ;; utility functions
  486.  
  487. (defun sc-completing-read (prompt table &optional predicate require-match
  488.                   initial-contents history)
  489.   "Compatibility between Emacs 18 and 19 `completing-read'.
  490. In version 18, the HISTORY argument is ignored."
  491.   (if (memq 'v19 sc-emacs-features)
  492.       (funcall 'completing-read prompt table predicate require-match
  493.            initial-contents history)
  494.     (funcall 'completing-read prompt table predicate require-match
  495.          (or (car-safe initial-contents)
  496.          initial-contents))))
  497.  
  498. (defun sc-read-string (prompt &optional initial-contents history)
  499.   "Compatibility between Emacs 18 and 19 `read-string'.
  500. In version 18, the HISTORY argument is ignored."
  501.   (if (memq 'v19 sc-emacs-features)
  502.       (funcall 'read-string prompt initial-contents history)
  503.     (funcall 'read-string prompt initial-contents)))
  504.  
  505. (defun sc-submatch (matchnum &optional string)
  506.   "Returns `match-beginning' and `match-end' sub-expression for MATCHNUM.
  507. If optional STRING is provided, take sub-expression using `substring'
  508. of argument, otherwise use `buffer-substring' on current buffer.  Note
  509. that `match-data' must have already been generated and no error
  510. checking is performed by this function."
  511.   (if string
  512.       (substring string (match-beginning matchnum) (match-end matchnum))
  513.     (buffer-substring (match-beginning matchnum) (match-end matchnum))))
  514.  
  515. (defun sc-member (elt list)
  516.   "Like `memq', but uses `equal' instead of `eq'.
  517. Emacs19 has a builtin function `member' which does exactly this."
  518.   (catch 'elt-is-member
  519.     (while list
  520.       (if (equal elt (car list))
  521.       (throw 'elt-is-member list))
  522.       (setq list (cdr list)))))
  523. (and (memq 'v19 sc-emacs-features)
  524.      (fset 'sc-member 'member))
  525.  
  526. (defun sc-ask (alist)
  527.   "Ask a question in the minibuffer requiring a single character answer.
  528. This function is kind of an extension of `y-or-n-p' where a single
  529. letter is used to answer a question.  Question is formed from ALIST
  530. which has members of the form:  (WORD . LETTER).  WORD is the long
  531. word form, while LETTER is the letter for selecting that answer.  The
  532. selected letter is returned, or nil if the question was not answered.
  533. Note that WORD is a string and LETTER is a character.  All LETTERs in
  534. the list should be unique."
  535.   (let* ((prompt (concat
  536.           (mapconcat (function (lambda (elt) (car elt))) alist ", ")
  537.           "? ("
  538.           (mapconcat
  539.            (function
  540.             (lambda (elt) (char-to-string (cdr elt)))) alist "/")
  541.           ") "))
  542.      (p prompt)
  543.      (event
  544.       (if (memq 'Lucid sc-emacs-features)
  545.           (allocate-event)
  546.         nil)))
  547.     (while (stringp p)
  548.       (if (let ((cursor-in-echo-area t)
  549.         (inhibit-quit t))
  550.         (message "%s" p)
  551.         ;; lets be good neighbors and be compatible with all emacsen
  552.         (cond
  553.          ((memq 'v18 sc-emacs-features)
  554.           (setq event (read-char)))
  555.          ((memq 'Lucid sc-emacs-features)
  556.           (next-command-event event))
  557.          (t                ; must be FSF19
  558.           (setq event (read-event))))
  559.         (prog1 quit-flag (setq quit-flag nil)))
  560.       (progn
  561.         (message "%s%s" p (single-key-description event))
  562.         (and (memq 'Lucid sc-emacs-features)
  563.          (deallocate-event event))
  564.         (setq quit-flag nil)
  565.         (signal 'quit '())))
  566.       (let ((char
  567.          (if (memq 'Lucid sc-emacs-features)
  568.          (let* ((key (and (key-press-event-p event) (event-key event)))
  569.             (char (and key (event-to-character event))))
  570.            char)
  571.            event))
  572.         elt)
  573.     (if char (setq char (downcase char)))
  574.     (cond
  575.      ((setq elt (rassq char alist))
  576.       (message "%s%s" p (car elt))
  577.       (setq p (cdr elt)))
  578.      ((and (memq 'Lucid sc-emacs-features)
  579.            (button-release-event-p event)) ; ignore them
  580.       nil)
  581.      (t
  582.       (message "%s%s" p (single-key-description event))
  583.       (if (memq 'Lucid sc-emacs-features)
  584.           (ding nil 'y-or-n-p)
  585.         (ding))
  586.       (discard-input)
  587.       (if (eq p prompt)
  588.           (setq p (concat "Try again.  " prompt)))))))
  589.     (and (memq 'Lucid sc-emacs-features)
  590.      (deallocate-event event))
  591.     p))
  592.  
  593. (defun sc-scan-info-alist (alist)
  594.   "Find a match in the info alist that matches a regexp in ALIST."
  595.   (let ((sc-mumble "")
  596.     rtnvalue)
  597.     (while alist
  598.       (let* ((elem    (car alist))
  599.          (infokey (car elem))
  600.          (infoval (sc-mail-field infokey))
  601.          (mlist   (car (cdr elem))))
  602.     (while mlist
  603.       (let* ((ml-elem (car mlist))
  604.          (regexp  (car ml-elem))
  605.          (thing   (cdr ml-elem)))
  606.         (if (string-match regexp infoval)
  607.         ;; we found a match, time to return
  608.         (setq rtnvalue thing
  609.               mlist nil
  610.               alist nil)
  611.           ;; else we didn't find a match
  612.           (setq mlist (cdr mlist))
  613.           )))            ;end of mlist loop
  614.     (setq alist (cdr alist))
  615.     ))                ;end of alist loop
  616.     rtnvalue))
  617.  
  618.  
  619. ;; ======================================================================
  620. ;; extract mail field information from headers in reply buffer
  621.  
  622. ;; holder variables for bc happiness
  623. (defvar sc-mail-headers-start nil
  624.   "Start of header fields.")
  625. (defvar sc-mail-headers-end nil
  626.   "End of header fields.")
  627. (defvar sc-mail-field-history nil
  628.   "For minibuffer completion on mail field queries.")
  629. (defvar sc-mail-field-modification-history nil
  630.   "For minibuffer completion on mail field modifications.")
  631. (defvar sc-mail-glom-frame
  632.   '((begin                        (setq sc-mail-headers-start (point)))
  633.     ("^x-attribution:[ \t]+.*$"   (sc-mail-fetch-field t) nil t)
  634.     ("^\\S +:.*$"                 (sc-mail-fetch-field) nil t)
  635.     ("^$"                         (list 'abort '(step . 0)))
  636.     ("^[ \t]+"                    (sc-mail-append-field))
  637.     (sc-mail-warn-if-non-rfc822-p (sc-mail-error-in-mail-field))
  638.     (end                          (setq sc-mail-headers-end (point))))
  639.   "Regi frame for glomming mail header information.")
  640.  
  641. ;; regi functions
  642. (defun sc-mail-fetch-field (&optional attribs-p)
  643.   "Insert a key and value into `sc-mail-info' alist.
  644. If optional ATTRIBS-P is non-nil, the key/value pair is placed in
  645. `sc-attributions' too."
  646.   (if (string-match "^\\(\\S *\\)\\s *:\\s +\\(.*\\)$" curline)
  647.       (let* ((key (downcase (sc-submatch 1 curline)))
  648.          (val (sc-submatch 2 curline))
  649.          (keyval (cons key val)))
  650.     (setq sc-mail-info (cons keyval sc-mail-info))
  651.     (if attribs-p
  652.         (setq sc-attributions (cons keyval sc-attributions)))
  653.     ))
  654.   nil)
  655.  
  656. (defun sc-mail-append-field ()
  657.   "Append a continuation line onto the last fetched mail field's info."
  658.   (let ((keyval (car sc-mail-info)))
  659.     (if (and keyval (string-match "^\\s *\\(.*\\)$" curline))
  660.     (setcdr keyval (concat (cdr keyval) " " (sc-submatch 1 curline)))))
  661.   nil)
  662.  
  663. (defun sc-mail-error-in-mail-field ()
  664.   "Issue warning that mail headers don't conform to RFC 822."
  665.   (let* ((len (min (length curline) 10))
  666.      (ellipsis (if (< len (length curline)) "..." ""))
  667.      (msg "Mail header \"%s%s\" doesn't conform to RFC 822. skipping..."))
  668.     (message msg (substring curline 0 len) ellipsis))
  669.   (beep)
  670.   (sit-for 2)
  671.   nil)
  672.  
  673. ;; mail header nuking
  674. (defvar sc-mail-last-header-nuked-p nil
  675.   "True if the last header was nuked.")
  676.  
  677. (defun sc-mail-nuke-line ()
  678.   "Nuke the current mail header line."
  679.   (delete-region (regi-pos 'bol) (regi-pos 'bonl))
  680.   '((step . -1)))
  681.  
  682. (defun sc-mail-nuke-header-line ()
  683.   "Delete current-line and set up for possible continuation."
  684.   (setq sc-mail-last-header-nuked-p t)
  685.   (sc-mail-nuke-line))
  686.  
  687. (defun sc-mail-nuke-continuation-line ()
  688.   "Delete a continuation line if the last header line was deleted."
  689.   (if sc-mail-last-header-nuked-p
  690.       (sc-mail-nuke-line)))
  691.  
  692. (defun sc-mail-cleanup-blank-lines ()
  693.   "Leave some blank lines after original mail headers are nuked.
  694. The number of lines left is specified by `sc-blank-lines-after-headers'."
  695.   (if sc-blank-lines-after-headers
  696.       (save-restriction
  697.     (widen)
  698.     (skip-chars-backward " \t\n")
  699.     (forward-line 1)
  700.     (delete-blank-lines)
  701.     (beginning-of-line)
  702.     (if (looking-at "[ \t]*$")
  703.         (delete-region (regi-pos 'bol) (regi-pos 'bonl)))
  704.     (insert-char ?\n sc-blank-lines-after-headers)))
  705.   nil)
  706.  
  707. (defun sc-mail-build-nuke-frame ()
  708.   "Build the regiframe for nuking mail headers."
  709.   (let (every-func entry-func nonentry-func)
  710.     (cond
  711.      ((eq sc-nuke-mail-headers 'all)
  712.       (setq every-func '(progn (forward-line -1) (sc-mail-nuke-line))))
  713.      ((eq sc-nuke-mail-headers 'specified)
  714.       (setq entry-func    '(sc-mail-nuke-header-line)
  715.         nonentry-func '(setq sc-mail-last-header-nuked-p nil)))
  716.      ((eq sc-nuke-mail-headers 'keep)
  717.       (setq entry-func    '(setq sc-mail-last-header-nuked-p nil)
  718.         nonentry-func '(sc-mail-nuke-header-line)))
  719.      ;; we never get far enough to interpret a frame if s-n-m-h == 'none
  720.      ((eq sc-nuke-mail-headers 'none))
  721.      (t (error "Illegal value for sc-nuke-mail-headers: %s"
  722.            sc-nuke-mail-headers))
  723.      )                    ; end-cond
  724.     (append
  725.      (and entry-func
  726.       (regi-mapcar sc-nuke-mail-header-list entry-func nil t))
  727.      (and nonentry-func (list (list "^\\S +:.*$" nonentry-func)))
  728.      (and (not every-func)
  729.       '(("^[ \t]+" (sc-mail-nuke-continuation-line))))
  730.      '((begin     (setq sc-mail-last-header-zapped-p nil)))
  731.      '((end       (sc-mail-cleanup-blank-lines)))
  732.      (and every-func (list (list 'every every-func)))
  733.      )))
  734.  
  735. ;; mail processing and zapping. this is the top level entry defun to
  736. ;; all header processing.
  737. (defun sc-mail-process-headers (start end)
  738.   "Process original mail message's mail headers.
  739. After processing, mail headers may be nuked.  Header information is
  740. stored in `sc-mail-info', and any old information is lost unless an
  741. error occurs."
  742.   (interactive "r")
  743.   (let ((info (copy-alist sc-mail-info))
  744.     (attribs (copy-alist sc-attributions)))
  745.     (setq sc-mail-info nil
  746.       sc-attributions nil)
  747.     (regi-interpret sc-mail-glom-frame start end)
  748.     (if (null sc-mail-info)
  749.     (progn
  750.       (message "No mail headers found! Restoring old information.")
  751.       (setq sc-mail-info info
  752.         sc-attributions attribs))
  753.       (regi-interpret (sc-mail-build-nuke-frame)
  754.               sc-mail-headers-start sc-mail-headers-end)
  755.       )))
  756.  
  757.  
  758. ;; let the user change mail field information
  759. (defun sc-mail-field (field)
  760.   "Return the mail header field value associated with FIELD.
  761. If there was no mail header with FIELD as its key, return the value of
  762. `sc-mumble'.  FIELD is case insensitive."
  763.   (or (cdr (assoc (downcase field) sc-mail-info)) sc-mumble))
  764.  
  765. (defun sc-mail-field-query (arg)
  766.   "View the value of a mail field.
  767. With `\\[universal-argument]', prompts for action on mail field.
  768. Action can be one of: View, Modify, Add, or Delete."
  769.   (interactive "P")
  770.   (let* ((alist '(("view" . ?v) ("modify" . ?m) ("add" . ?a) ("delete" . ?d)))
  771.      (action (if (not arg) ?v (sc-ask alist)))
  772.      key)
  773.     (if (not action)
  774.     ()
  775.       (setq key (sc-completing-read
  776.          (concat (car (rassq action alist))
  777.                   " information key: ")
  778.          sc-mail-info nil
  779.          (if (eq action ?a) nil 'noexit)
  780.          nil 'sc-mail-field-history))
  781.       (cond
  782.        ((eq action ?v)
  783.     (message "%s: %s" key (cdr (assoc key sc-mail-info))))
  784.        ((eq action ?d)
  785.     (setq sc-mail-info (delq (assoc key sc-mail-info) sc-mail-info)))
  786.        ((eq action ?m)
  787.     (let ((keyval (assoc key sc-mail-info)))
  788.       ;; first put initial value onto list if not already there
  789.       (if (not (sc-member (cdr keyval)
  790.                   sc-mail-field-modification-history))
  791.           (setq sc-mail-field-modification-history
  792.             (cons (cdr keyval) sc-mail-field-modification-history)))
  793.       (setcdr keyval (sc-read-string
  794.               (concat key ": ") (cdr keyval)
  795.               'sc-mail-field-modification-history))))
  796.        ((eq action ?a)
  797.     (setq sc-mail-info
  798.           (cons (cons key
  799.               (sc-read-string (concat key ": "))) sc-mail-info)))
  800.        ))))
  801.  
  802.  
  803. ;; ======================================================================
  804. ;; attributions
  805.  
  806. (defvar sc-attribution-confirmation-history nil
  807.   "History for confirmation of attribution strings.")
  808. (defvar sc-citation-confirmation-history nil
  809.   "History for confirmation of attribution prefixes.")
  810.  
  811. (defun sc-attribs-%@-addresses (from &optional delim)
  812.   "Extract the author's email terminus from email address FROM.
  813. Match addresses of the style ``name%[stuff].'' when called with DELIM
  814. of \"%\" and addresses of the style ``[stuff]name@[stuff]'' when
  815. called with DELIM \"@\".  If DELIM is nil or not provided, matches
  816. addresses of the style ``name''."
  817.   (and (string-match (concat "[-a-zA-Z0-9_.]+" delim) from 0)
  818.        (substring from
  819.           (match-beginning 0)
  820.           (- (match-end 0) (if (null delim) 0 1)))))
  821.  
  822. (defun sc-attribs-!-addresses (from)
  823.   "Extract the author's email terminus from email address FROM.
  824. Match addresses of the style ``[stuff]![stuff]...!name[stuff].''"
  825.   (let ((eos (length from))
  826.     (mstart (string-match "![-a-zA-Z0-9_.]+\\([^-!a-zA-Z0-9_.]\\|$\\)"
  827.                   from 0))
  828.     (mend (match-end 0)))
  829.     (and mstart
  830.      (substring from (1+ mstart) (- mend (if (= mend eos) 0 1)))
  831.      )))
  832.  
  833. (defun sc-attribs-<>-addresses (from)
  834.   "Extract the author's email terminus from email address FROM.
  835. Match addresses of the style ``<name[stuff]>.''"
  836.   (and (string-match "<\\(.*\\)>" from)
  837.        (sc-submatch 1 from)))
  838.  
  839. (defun sc-get-address (from author)
  840.   "Get the full email address path from FROM.
  841. AUTHOR is the author's name (which is removed from the address)."
  842.   (let ((eos (length from)))
  843.     (if (string-match (concat "\\(^\\|^\"\\)" author
  844.                   "\\(\\s +\\|\"\\s +\\)") from 0)
  845.     (let ((address (substring from (match-end 0) eos)))
  846.       (if (and (= (aref address 0) ?<)
  847.            (= (aref address (1- (length address))) ?>))
  848.           (substring address 1 (1- (length address)))
  849.         address))
  850.       (if (string-match "[-a-zA-Z0-9!@%._]+" from 0)
  851.       (sc-submatch 0 from)
  852.     "")
  853.       )))
  854.  
  855. (defun sc-attribs-emailname (from)
  856.   "Get the email terminus name from FROM."
  857.   (or
  858.    (sc-attribs-%@-addresses from "%")
  859.    (sc-attribs-%@-addresses from "@")
  860.    (sc-attribs-!-addresses  from)
  861.    (sc-attribs-<>-addresses from)
  862.    (sc-attribs-%@-addresses from)
  863.    (substring from 0 10)))
  864.  
  865. (defun sc-name-substring (string start end extend)
  866.   "Extract the specified substring of STRING from START to END.
  867. EXTEND is the number of characters on each side to extend the
  868. substring."
  869.   (and start
  870.        (let ((sos (+ start extend))
  871.          (eos (- end extend)))
  872.      (substring string sos
  873.             (or (string-match sc-titlecue-regexp string sos) eos)
  874.             ))))
  875.  
  876. (defun sc-attribs-extract-namestring (from)
  877.   "Extract the name string from FROM.
  878. This should be the author's full name minus an optional title."
  879.   (let ((namestring
  880.      (or
  881.       (sc-name-substring
  882.        from (string-match "(.*)" from 0) (match-end 0) 1)
  883.       (sc-name-substring
  884.        from (string-match "\".*\"" from 0) (match-end 0) 1)
  885.       (sc-name-substring
  886.        from (string-match "\\([-.a-zA-Z0-9_]+\\s +\\)+<" from 0)
  887.        (match-end 1) 0)
  888.       (sc-attribs-emailname from))))
  889.     ;; strip off any leading or trailing whitespace
  890.     (if namestring
  891.     (let ((bos 0)
  892.           (eos (1- (length namestring))))
  893.       (while (and (<= bos eos)
  894.               (memq (aref namestring bos) '(32 ?\t)))
  895.         (setq bos (1+ bos)))
  896.       (while (and (> eos bos)
  897.               (memq (aref namestring eos) '(32 ?\t)))
  898.         (setq eos (1- eos)))
  899.       (substring namestring bos (1+ eos))))))
  900.  
  901. (defun sc-attribs-chop-namestring (namestring)
  902.   "Convert NAMESTRING to a list of names.
  903. example: (sc-namestring-to-list \"John Xavier Doe\")
  904.          => (\"John\" \"Xavier\" \"Doe\")"
  905.   (if (string-match "\\([ \t]*\\)\\([^ \t._]+\\)\\([ \t]*\\)" namestring)
  906.       (cons (sc-submatch 2 namestring)
  907.         (sc-attribs-chop-namestring (substring namestring (match-end 3)))
  908.         )))
  909.  
  910. (defun sc-attribs-strip-initials (namelist)
  911.   "Extract the author's initials from the NAMELIST."
  912.   (mapconcat
  913.    (function
  914.     (lambda (name)
  915.       (if (< 0 (length name))
  916.       (substring name 0 1))))
  917.    namelist ""))
  918.  
  919. (defun sc-guess-attribution (&optional string)
  920.   "Guess attribution string on current line.
  921. If attribution cannot be guessed, nil is returned.  Optional STRING if
  922. supplied, is used instead of the line point is on in the current buffer."
  923.   (let ((start 0)
  924.     (string (or string (buffer-substring (regi-pos 'bol) (regi-pos 'eol))))
  925.     attribution)
  926.     (and
  927.      (= start (or (string-match sc-citation-leader-regexp string start) -1))
  928.      (setq start (match-end 0))
  929.      (= start (or (string-match sc-citation-root-regexp string start) 1))
  930.      (setq attribution (sc-submatch 0 string)
  931.        start (match-end 0))
  932.      (= start (or (string-match sc-citation-delimiter-regexp string start) -1))
  933.      (setq start (match-end 0))
  934.      (= start (or (string-match sc-citation-separator-regexp string start) -1))
  935.      attribution)))
  936.  
  937. (defun sc-attribs-filter-namelist (namelist)
  938.   "Filter out noise in NAMELIST according to `sc-name-filter-alist'."
  939.   (let ((elements (length namelist))
  940.     (position -1)
  941.     keepers filtered-list)
  942.     (mapcar
  943.      (function
  944.       (lambda (name)
  945.     (setq position (1+ position))
  946.     (let ((keep-p t))
  947.       (mapcar
  948.        (function
  949.         (lambda (filter)
  950.           (let ((regexp (car filter))
  951.             (pos (cdr filter)))
  952.         (if (and (string-match regexp name)
  953.              (or (and (numberp pos)
  954.                   (= pos position))
  955.                  (and (eq pos 'last)
  956.                   (= position (1- elements)))
  957.                  (eq pos 'any)))
  958.             (setq keep-p nil))
  959.         )))
  960.        sc-name-filter-alist)
  961.       (if keep-p
  962.           (setq keepers (cons position keepers)))
  963.       )))
  964.      namelist)
  965.     (mapcar
  966.      (function
  967.       (lambda (position)
  968.     (setq filtered-list (cons (nth position namelist) filtered-list))
  969.     ))
  970.      keepers)
  971.     filtered-list))
  972.  
  973. (defun sc-attribs-chop-address (from)
  974.   "Extract attribution information from FROM.
  975. This populates the `sc-attributions' with the list of possible attributions."
  976.   (if (and (stringp from)
  977.        (< 0 (length from)))
  978.       (let* ((sc-mumble "")         
  979.          (namestring (sc-attribs-extract-namestring from))
  980.          (namelist   (sc-attribs-filter-namelist
  981.               (sc-attribs-chop-namestring namestring)))
  982.          (revnames   (reverse (cdr namelist)))
  983.          (firstname  (car namelist))
  984.          (midnames   (reverse (cdr revnames)))
  985.          (lastname   (car revnames))
  986.          (initials   (sc-attribs-strip-initials namelist))
  987.          (emailname  (sc-attribs-emailname from))
  988.          (n 1)
  989.          author middlenames)
  990.     
  991.     ;; put basic information
  992.     (setq
  993.      ;; put middle names and build sc-author entry
  994.      middlenames (mapconcat
  995.               (function
  996.                (lambda (midname)
  997.              (let ((key-attribs (format "middlename-%d" n))
  998.                    (key-mail    (format "sc-middlename-%d" n)))
  999.                (setq
  1000.                 sc-attributions (cons (cons key-attribs midname)
  1001.                           sc-attributions)
  1002.                 sc-mail-info (cons (cons key-mail midname)
  1003.                            sc-mail-info)
  1004.                 n (1+ n))
  1005.                midname)))
  1006.               midnames " ")
  1007.  
  1008.      author (concat firstname " " middlenames (and midnames " ") lastname)
  1009.  
  1010.      sc-attributions (append
  1011.               (list
  1012.                (cons "firstname"   firstname)
  1013.                (cons "lastname"    lastname)
  1014.                (cons "emailname"   emailname)
  1015.                (cons "initials"    initials))
  1016.               sc-attributions)
  1017.      sc-mail-info (append
  1018.                (list
  1019.             (cons "sc-firstname"   firstname)
  1020.             (cons "sc-middlenames" middlenames)
  1021.             (cons "sc-lastname"    lastname)
  1022.             (cons "sc-emailname"   emailname)
  1023.             (cons "sc-initials"    initials)
  1024.             (cons "sc-author"      author)
  1025.             (cons "sc-from-address" (sc-get-address
  1026.                          (sc-mail-field "from")
  1027.                          namestring))
  1028.             (cons "sc-reply-address" (sc-get-address
  1029.                           (sc-mail-field "reply-to")
  1030.                           namestring))
  1031.             (cons "sc-sender-address" (sc-get-address
  1032.                            (sc-mail-field "sender")
  1033.                            namestring))
  1034.             )
  1035.                sc-mail-info)
  1036.      ))
  1037.     ;; from string is empty
  1038.     (setq sc-mail-info (cons (cons "sc-author" sc-default-author-name)
  1039.                  sc-mail-info))))
  1040.  
  1041. (defvar sc-attrib-or-cite nil
  1042.   "Used to toggle between attribution input or citation input.")
  1043.  
  1044. (defun sc-toggle-fn ()
  1045.   "Toggle between attribution selection and citation selection.
  1046. Only used during confirmation."
  1047.   (interactive)
  1048.   (setq sc-attrib-or-cite (not sc-attrib-or-cite))
  1049.   (throw 'sc-reconfirm t))
  1050.  
  1051. (defun sc-select-attribution ()
  1052.   "Select an attribution from `sc-attributions'.
  1053.  
  1054. Variables involved in selection process include:
  1055.      `sc-preferred-attribution-list'
  1056.      `sc-use-only-preference-p'
  1057.      `sc-confirm-always-p'
  1058.      `sc-default-attribution'
  1059.      `sc-attrib-selection-list'.
  1060.  
  1061. Runs the hook `sc-attribs-preselect-hook' before selecting an
  1062. attribution and the hook `sc-attribs-postselect-hook' after making the
  1063. selection but before querying is performed.  During
  1064. `sc-attribs-postselect-hook' the variable `citation' is bound to the
  1065. auto-selected citation string and the variable `attribution' is bound
  1066. to the auto-selected attribution string."
  1067.   (run-hooks 'sc-attribs-preselect-hook)
  1068.   (let ((query-p sc-confirm-always-p)
  1069.     attribution citation
  1070.     (attriblist sc-preferred-attribution-list))
  1071.  
  1072.     ;; first cruise through sc-preferred-attribution-list looking for
  1073.     ;; a match in either sc-attributions or sc-mail-info.  if the
  1074.     ;; element is "sc-consult", then we have to do the alist
  1075.     ;; consultation phase
  1076.     (while attriblist
  1077.       (let* ((preferred (car attriblist)))
  1078.     (cond
  1079.      ((string= preferred "sc-consult")
  1080.       ;; we've been told to consult the attribution vs. mail
  1081.       ;; header key alist.  we do this until we find a match in
  1082.       ;; the sc-attrib-selection-list.  if we do not find a match,
  1083.       ;; we continue scanning attriblist
  1084.       (let ((attrib (sc-scan-info-alist sc-attrib-selection-list)))
  1085.         (cond
  1086.          ((not attrib)
  1087.           (setq attriblist (cdr attriblist)))
  1088.          ((stringp attrib)
  1089.           (setq attribution attrib
  1090.             attriblist nil))
  1091.          ((listp attrib)
  1092.           (setq attribution (eval attrib)
  1093.             attriblist nil))
  1094.          (t (error "%s did not evaluate to a string or list!"
  1095.                "sc-attrib-selection-list"))
  1096.          )))
  1097.      ((setq attribution (cdr (assoc preferred sc-attributions)))
  1098.       (setq attriblist nil))
  1099.      (t
  1100.       (setq attriblist (cdr attriblist)))
  1101.      )))
  1102.  
  1103.     ;; if preference was not found, we may use a secondary method to
  1104.     ;; find a valid attribution
  1105.     (if (and (not attribution)
  1106.          (not sc-use-only-preference-p))
  1107.     ;; secondary method tries to find a preference in this order
  1108.     ;; 1. sc-lastchoice
  1109.     ;; 2. x-attribution
  1110.     ;; 3. firstname
  1111.     ;; 4. lastname
  1112.     ;; 5. initials
  1113.     ;; 6. first non-empty attribution in alist
  1114.     (setq attribution
  1115.           (or (cdr (assoc "sc-lastchoice" sc-attributions))
  1116.           (cdr (assoc "x-attribution" sc-attributions))
  1117.           (cdr (assoc "firstname" sc-attributions))
  1118.           (cdr (assoc "lastname" sc-attributions))
  1119.           (cdr (assoc "initials" sc-attributions))
  1120.           (cdr (car sc-attributions)))))
  1121.  
  1122.     ;; still couldn't find an attribution. we're now limited to using
  1123.     ;; the default attribution, but we'll force a query when this happens
  1124.     (if (not attribution)
  1125.     (setq attribution sc-default-attribution
  1126.           query-p t))
  1127.  
  1128.     ;; create the attribution prefix
  1129.     (setq citation (sc-make-citation attribution))
  1130.  
  1131.     ;; run the post selection hook before querying the user
  1132.     (run-hooks 'sc-attribs-postselect-hook)
  1133.  
  1134.     ;; query for confirmation
  1135.     (if query-p
  1136.     (let* ((query-alist (mapcar (function (lambda (entry)
  1137.                         (list (cdr entry))))
  1138.                     sc-attributions))
  1139.            (minibuffer-local-completion-map
  1140.         sc-minibuffer-local-completion-map)
  1141.            (minibuffer-local-map sc-minibuffer-local-map)
  1142.            (initial attribution)
  1143.            (completer-disable t)    ; in case completer.el is used
  1144.            choice)
  1145.       (setq sc-attrib-or-cite nil)    ; nil==attribution, t==citation
  1146.       (while
  1147.           (catch 'sc-reconfirm
  1148.         (string= "" (setq choice
  1149.                   (if sc-attrib-or-cite
  1150.                       (sc-read-string
  1151.                        "Enter citation prefix: "
  1152.                        citation
  1153.                        'sc-citation-confirmation-history)
  1154.                     (sc-completing-read
  1155.                      "Complete attribution name: "
  1156.                      query-alist nil nil
  1157.                      (cons initial 0)
  1158.                      'sc-attribution-confirmation-history)
  1159.                     )))))
  1160.       (if sc-attrib-or-cite
  1161.           ;; since the citation was chosen, we have to guess at
  1162.           ;; the attribution
  1163.           (setq citation choice
  1164.             attribution (or (sc-guess-attribution citation)
  1165.                     citation))
  1166.         
  1167.         (setq citation (sc-make-citation choice)
  1168.           attribution choice))
  1169.       ))
  1170.  
  1171.     ;; its possible that the user wants to downcase the citation and
  1172.     ;; attribution
  1173.     (if sc-downcase-p
  1174.     (setq citation (downcase citation)
  1175.           attribution (downcase attribution)))
  1176.  
  1177.     ;; set up mail info alist
  1178.     (let* ((ckey "sc-citation")
  1179.        (akey "sc-attribution")
  1180.        (ckeyval (assoc ckey sc-mail-info))
  1181.        (akeyval (assoc akey sc-mail-info)))
  1182.       (if ckeyval
  1183.       (setcdr ckeyval citation)
  1184.     (setq sc-mail-info
  1185.           (append (list (cons ckey citation)) sc-mail-info)))
  1186.       (if akeyval
  1187.       (setcdr akeyval attribution)
  1188.     (setq sc-mail-info
  1189.           (append (list (cons akey attribution)) sc-mail-info))))
  1190.  
  1191.     ;; set the sc-lastchoice attribution
  1192.     (let* ((lkey "sc-lastchoice")
  1193.        (lastchoice (assoc lkey sc-attributions)))
  1194.       (if lastchoice
  1195.       (setcdr lastchoice attribution)
  1196.     (setq sc-attributions
  1197.           (cons (cons lkey attribution) sc-attributions))))
  1198.     ))
  1199.  
  1200.  
  1201. ;; ======================================================================
  1202. ;; filladapt hooks for supercite 3.1. you shouldn't need anything
  1203. ;; extra to make gin-mode understand supercited lines.  Even this
  1204. ;; stuff might not be entirely necessary...
  1205.  
  1206. (defun sc-cite-regexp (&optional root-regexp)
  1207.   "Return a regexp describing a Supercited line.
  1208. The regexp is the concatenation of `sc-citation-leader-regexp',
  1209. `sc-citation-root-regexp', `sc-citation-delimiter-regexp', and
  1210. `sc-citation-separator-regexp'.  If optional ROOT-REGEXP is supplied,
  1211. use it instead of `sc-citation-root-regexp'."
  1212.   (concat sc-citation-leader-regexp
  1213.       (or root-regexp sc-citation-root-regexp)
  1214.       sc-citation-delimiter-regexp
  1215.       sc-citation-separator-regexp))
  1216.  
  1217. (defun sc-make-citation (attribution)
  1218.   "Make a non-nested citation from ATTRIBUTION."
  1219.   (concat sc-citation-leader
  1220.       attribution
  1221.       sc-citation-delimiter
  1222.       sc-citation-separator))
  1223.  
  1224. (defun sc-setup-filladapt ()
  1225.   "Setup `filladapt-prefix-table' to handle Supercited paragraphs."
  1226.   (let* ((fa-sc-elt 'filladapt-supercite-included-text)
  1227.      (elt (rassq fa-sc-elt filladapt-prefix-table)))
  1228.     (if elt (setcar elt (sc-cite-regexp))
  1229.       (message "Filladapt doesn't seem to know about Supercite.")
  1230.       (beep))))
  1231.  
  1232.  
  1233. ;; ======================================================================
  1234. ;; citing and unciting regions of text
  1235.  
  1236. (defvar sc-fill-begin 1
  1237.   "Buffer position to begin filling.")
  1238. (defvar sc-fill-line-prefix ""
  1239.   "Fill prefix of previous line")
  1240.  
  1241. ;; filling
  1242. (defun sc-fill-if-different (&optional prefix)
  1243.   "Fill the region bounded by `sc-fill-begin' and point.
  1244. Only fill if optional PREFIX is different than `sc-fill-line-prefix'.
  1245. If `sc-auto-fill-region-p' is nil, do not fill region.  If PREFIX is
  1246. not supplied, initialize fill variables.  This is useful for a regi
  1247. `begin' frame-entry."
  1248.   (if (not prefix)
  1249.       (setq sc-fill-line-prefix ""
  1250.         sc-fill-begin (regi-pos 'bol))
  1251.     (if (and sc-auto-fill-region-p
  1252.          (not (string= prefix sc-fill-line-prefix)))
  1253.     (let ((fill-prefix sc-fill-line-prefix))
  1254.       (if (not (string= fill-prefix ""))
  1255.           (fill-region sc-fill-begin (regi-pos 'bol)))
  1256.       (setq sc-fill-line-prefix prefix
  1257.         sc-fill-begin (regi-pos 'bol))))
  1258.     )
  1259.   nil)
  1260.  
  1261. (defun sc-cite-coerce-cited-line ()
  1262.   "Coerce a Supercited line to look like our style."
  1263.   (let* ((attribution (sc-guess-attribution))
  1264.      (regexp (sc-cite-regexp attribution))
  1265.      (prefix (sc-make-citation attribution)))
  1266.     (if (and attribution
  1267.          (looking-at regexp))
  1268.     (progn
  1269.       (delete-region
  1270.        (match-beginning 0)
  1271.        (save-excursion
  1272.          (goto-char (match-end 0))
  1273.          (if (bolp) (forward-char -1))
  1274.          (point)))
  1275.       (insert prefix)
  1276.       (sc-fill-if-different prefix)))
  1277.     nil))
  1278.  
  1279. (defun sc-cite-coerce-dumb-citer ()
  1280.   "Coerce a non-nested citation that's been cited with a dumb nesting citer."
  1281.   (delete-region (match-beginning 1) (match-end 1))
  1282.   (beginning-of-line)
  1283.   (sc-cite-coerce-cited-line))
  1284.  
  1285. (defun sc-guess-nesting (&optional string)
  1286.   "Guess the citation nesting on the current line.
  1287. If nesting cannot be guessed, nil is returned.  Optional STRING if
  1288. supplied, is used instead of the line point is on in the current
  1289. buffer."
  1290.   (let ((start 0)
  1291.     (string (or string (buffer-substring (regi-pos 'bol) (regi-pos 'eol))))
  1292.     nesting)
  1293.     (and
  1294.      (= start (or (string-match sc-citation-leader-regexp string start) -1))
  1295.      (setq start (match-end 0))
  1296.      (= start (or (string-match sc-citation-delimiter-regexp string start) -1))
  1297.      (setq nesting (sc-submatch 0 string)
  1298.        start (match-end 0))
  1299.      (= start (or (string-match sc-citation-separator-regexp string start) -1))
  1300.      nesting)))
  1301.  
  1302. (defun sc-add-citation-level ()
  1303.   "Add a citation level for nested citation style w/ coersion."
  1304.   (let* ((nesting (sc-guess-nesting))
  1305.      (citation (make-string (1+ (length nesting))
  1306.                 (string-to-char sc-citation-delimiter)))
  1307.      (prefix (concat sc-citation-leader citation sc-citation-separator)))
  1308.     (if (looking-at (sc-cite-regexp ""))
  1309.     (delete-region (match-beginning 0) (match-end 0)))
  1310.     (insert prefix)
  1311.     (sc-fill-if-different prefix)))
  1312.  
  1313. (defun sc-cite-line (&optional citation)
  1314.   "Cite a single line of uncited text.
  1315. Optional CITATION overrides any citation automatically selected."
  1316.   (if sc-fixup-whitespace-p
  1317.       (fixup-whitespace))
  1318.   (let ((prefix (or citation
  1319.             (cdr (assoc "sc-citation" sc-mail-info))
  1320.             sc-default-attribution)))
  1321.     (insert prefix)
  1322.     (sc-fill-if-different prefix))
  1323.   nil)
  1324.  
  1325. (defun sc-uncite-line ()
  1326.   "Remove citation from current line."
  1327.   (let ((cited (looking-at (sc-cite-regexp))))
  1328.     (if cited
  1329.     (delete-region (match-beginning 0) (match-end 0))))
  1330.   nil)
  1331.  
  1332. (defun sc-recite-line (regexp)
  1333.   "Remove citation matching REGEXP from current line and recite line."
  1334.   (let ((cited (looking-at (concat "^" regexp)))
  1335.     (prefix (cdr (assoc "sc-citation" sc-mail-info))))
  1336.     (if cited
  1337.     (delete-region (match-beginning 0) (match-end 0)))
  1338.     (insert (or prefix sc-default-attribution))
  1339.     (sc-fill-if-different prefix))
  1340.   nil)
  1341.  
  1342. ;; interactive functions
  1343. (defun sc-cite-region (start end &optional confirm-p)
  1344.   "Cite a region delineated by START and END.
  1345. If optional CONFIRM-P is non-nil, the attribution is confirmed before
  1346. its use in the citation string.  This function first runs
  1347. `sc-pre-cite-hook'."
  1348.   (interactive "r\nP")
  1349.   (undo-boundary)
  1350.   (let ((frame (or (sc-scan-info-alist sc-cite-frame-alist)
  1351.            sc-default-cite-frame))
  1352.     (sc-confirm-always-p (if confirm-p t sc-confirm-always-p)))
  1353.     (run-hooks 'sc-pre-cite-hook)
  1354.     (if (interactive-p)
  1355.     (sc-select-attribution))
  1356.     (regi-interpret frame start end)))
  1357.  
  1358. (defun sc-uncite-region (start end)
  1359.   "Uncite a region delineated by START and END.
  1360. First runs `sc-pre-uncite-hook'."
  1361.   (interactive "r")
  1362.   (undo-boundary)
  1363.   (let ((frame (or (sc-scan-info-alist sc-uncite-frame-alist)
  1364.            sc-default-uncite-frame)))
  1365.     (run-hooks 'sc-pre-uncite-hook)
  1366.     (regi-interpret frame start end)))
  1367.       
  1368. (defun sc-recite-region (start end)
  1369.   "Recite a region delineated by START and END.
  1370. First runs `sc-pre-recite-hook'."
  1371.   (interactive "r")
  1372.   (let ((sc-confirm-always-p t))
  1373.     (sc-select-attribution))
  1374.   (undo-boundary)
  1375.   (let ((frame (or (sc-scan-info-alist sc-recite-frame-alist)
  1376.            sc-default-recite-frame)))
  1377.     (run-hooks 'sc-pre-recite-hook)
  1378.     (regi-interpret frame start end)))
  1379.  
  1380.  
  1381. ;; ======================================================================
  1382. ;; building headers
  1383.  
  1384. (defun sc-hdr (prefix field &optional sep return-nil-p)
  1385.   "Returns a concatenation of PREFIX and FIELD.
  1386. If FIELD is not a string or is the empty string, the empty string will
  1387. be returned.  Optional third argument SEP is concatenated on the end if
  1388. it is a string.  Returns empty string, unless optional RETURN-NIL-P is
  1389. non-nil."
  1390.   (if (and (stringp field)
  1391.        (not (string= field "")))
  1392.       (concat prefix field (or sep ""))
  1393.     (and (not return-nil-p) "")))
  1394.  
  1395. (defun sc-whofrom ()
  1396.   "Return the value of (sc-mail-field \"from\") or nil."
  1397.   (let ((sc-mumble nil))
  1398.     (sc-mail-field "from")))
  1399.  
  1400. (defun sc-no-header ()
  1401.   "Does nothing.  Use this instead of nil to get a blank header."
  1402.   ())
  1403.  
  1404. (defun sc-no-blank-line-or-header()
  1405.   "Similar to `sc-no-header' except it removes the preceeding blank line."
  1406.   (if (not (bobp))
  1407.       (if (and (eolp)
  1408.            (progn (forward-line -1)
  1409.               (or (looking-at mail-header-separator)
  1410.               (and (eq major-mode 'mh-letter-mode)
  1411.                    (mh-in-header-p)))))
  1412.       (progn (forward-line)
  1413.          (let ((kill-lines-magic t))
  1414.            (kill-line))))))
  1415.  
  1416. (defun sc-header-on-said ()
  1417.   "\"On <date>, <from> said:\" unless:
  1418. 1. the \"from\" field cannot be found, in which case nothing is inserted;
  1419. 2. the \"date\" field is missing in which case only the from part is printed."
  1420.   (let ((sc-mumble "")
  1421.     (whofrom (sc-whofrom)))
  1422.     (if whofrom
  1423.     (insert sc-reference-tag-string
  1424.         (sc-hdr "On " (sc-mail-field "date") ", ")
  1425.         whofrom " said:\n"))))
  1426.  
  1427. (defun sc-header-inarticle-writes ()
  1428.   "\"In article <message-id>, <from> writes:\"
  1429. Treats \"message-id\" and \"from\" fields similar to `sc-header-on-said'."
  1430.   (let ((sc-mumble "")
  1431.     (whofrom (sc-mail-field "from")))
  1432.     (if whofrom
  1433.     (insert sc-reference-tag-string
  1434.         (sc-hdr "In article " (sc-mail-field "message-id") ", ")
  1435.         whofrom " writes:\n"))))
  1436.  
  1437. (defun sc-header-regarding-adds ()
  1438.   "\"Regarding <subject>; <from> adds:\"
  1439. Treats \"subject\" and \"from\" fields similar to `sc-header-on-said'."
  1440.   (let ((sc-mumble "")
  1441.     (whofrom (sc-whofrom)))
  1442.     (if whofrom
  1443.     (insert sc-reference-tag-string
  1444.         (sc-hdr "Regarding " (sc-mail-field "subject") "; ")
  1445.         whofrom " adds:\n"))))
  1446.  
  1447. (defun sc-header-attributed-writes ()
  1448.   "\"<sc-attribution>\" == <sc-author> <address> writes:
  1449. Treats these fields in a similar manner to `sc-header-on-said'."
  1450.   (let ((sc-mumble "")
  1451.     (whofrom (sc-whofrom)))
  1452.     (if whofrom
  1453.     (insert sc-reference-tag-string
  1454.         (sc-hdr "\"" (sc-mail-field "sc-attribution") "\" == ")
  1455.         (sc-hdr ""   (sc-mail-field "sc-author") " ")
  1456.         (or (sc-hdr "<" (sc-mail-field "sc-from-address") ">" t)
  1457.             (sc-hdr "<" (sc-mail-field "sc-reply-address") ">"  t)
  1458.             "")
  1459.         " writes:\n"))))
  1460.  
  1461. (defun sc-header-author-writes ()
  1462.   "<sc-author> writes:"
  1463.   (let ((sc-mumble "")
  1464.     (whofrom (sc-whofrom)))
  1465.     (if whofrom
  1466.     (insert sc-reference-tag-string
  1467.         (sc-hdr "" (sc-mail-field "sc-author"))
  1468.         " writes:\n"))))
  1469.  
  1470. (defun sc-header-verbose ()
  1471.   "Very verbose, some say gross."
  1472.   (let ((sc-mumble "")
  1473.     (whofrom (sc-whofrom))
  1474.     (tag sc-reference-tag-string))
  1475.     (if whofrom
  1476.     (insert (sc-hdr (concat tag "On ") (sc-mail-field "date") ",\n")
  1477.         (or (sc-hdr tag (sc-mail-field "sc-author") "\n" t)
  1478.             (concat tag whofrom "\n"))
  1479.         (sc-hdr (concat tag "from the organization of ")
  1480.             (sc-mail-field "organization") "\n")
  1481.         (let ((rtag (concat tag "who can be reached at: ")))
  1482.           (or (sc-hdr rtag (sc-mail-field "sc-from-address") "\n" t)
  1483.               (sc-hdr rtag (sc-mail-field "sc-reply-address")  "\n" t)
  1484.               ""))
  1485.         (sc-hdr
  1486.          (concat tag "(whose comments are cited below with \"")
  1487.          (sc-mail-field "sc-citation") "\"),\n")
  1488.         (sc-hdr (concat tag "had this to say in article ")
  1489.             (sc-mail-field "message-id") "\n")
  1490.         (sc-hdr (concat tag "in newsgroups ")
  1491.             (sc-mail-field "newsgroups") "\n")
  1492.         (sc-hdr (concat tag "concerning the subject of ")
  1493.             (sc-mail-field "subject") "\n")
  1494.         (sc-hdr (concat tag "(see ")
  1495.             (sc-mail-field "references")
  1496.             " for more details)\n")
  1497.         ))))
  1498.  
  1499.  
  1500. ;; ======================================================================
  1501. ;; header rewrites
  1502.  
  1503. (defconst sc-electric-bufname " *sc-erefs* "
  1504.   "Supercite electric reference mode's buffer name.")
  1505. (defvar sc-eref-style 0
  1506.   "Current electric reference style.")
  1507.  
  1508. (defun sc-valid-index-p (index)
  1509.   "Returns INDEX if it is a valid index into `sc-rewrite-header-list'.
  1510. Otherwise returns nil."
  1511.     ;; a number, and greater than or equal to zero
  1512.     ;; less than or equal to the last index
  1513.     (and (natnump index)
  1514.      (< index (length sc-rewrite-header-list))
  1515.      index))
  1516.  
  1517. (defun sc-eref-insert-selected (&optional nomsg)
  1518.   "Insert the selected reference header in the current buffer.
  1519. Optional NOMSG, if non-nil, inhibits printing messages, unless an
  1520. error occurs."
  1521.   (let ((ref (nth sc-eref-style sc-rewrite-header-list)))
  1522.     (condition-case err
  1523.     (progn
  1524.       (eval ref)
  1525.       (let ((lines (count-lines (point-min) (point-max))))
  1526.         (or nomsg (message "Ref header %d [%d line%s]: %s" 
  1527.                    sc-eref-style lines
  1528.                    (if (= lines 1) "" "s")
  1529.                    ref))))
  1530.       (void-function
  1531.        (progn (message
  1532.            "Symbol's function definition is void: %s (Header %d)"
  1533.            (car (cdr err)) sc-eref-style)
  1534.           (beep)
  1535.           ))
  1536.       )))
  1537.  
  1538. (defun sc-electric-mode (&optional arg)
  1539.   "
  1540. Mode for viewing Supercite reference headers.  Commands are:
  1541. \n\\{sc-electric-mode-map}
  1542.  
  1543. `sc-electric-mode' is not intended to be run interactively, but rather
  1544. accessed through Supercite's electric reference feature.  See
  1545. `sc-insert-reference' for more details.  Optional ARG is the initial
  1546. header style to use, unless not supplied or invalid, in which case
  1547. `sc-preferred-header-style' is used."
  1548.  
  1549.   (let ((info sc-mail-info))
  1550.  
  1551.     (setq sc-eref-style
  1552.       (or (sc-valid-index-p arg)
  1553.           (sc-valid-index-p sc-preferred-header-style)
  1554.           0))
  1555.  
  1556.     (get-buffer-create sc-electric-bufname)
  1557.     ;; set up buffer and enter command loop
  1558.     (save-excursion
  1559.       (save-window-excursion
  1560.     (pop-to-buffer sc-electric-bufname)
  1561.     (kill-all-local-variables)
  1562.     (let ((sc-mail-info info)
  1563.           (buffer-read-only t)
  1564.           (mode-name "SC Electric Refs")
  1565.           (major-mode 'sc-electric-mode))
  1566.       (use-local-map sc-electric-mode-map)
  1567.       (sc-eref-show sc-eref-style)
  1568.       (run-hooks 'sc-electric-mode-hook)
  1569.       (recursive-edit)
  1570.       )))
  1571.  
  1572.     (and sc-eref-style
  1573.      (sc-eref-insert-selected))
  1574.     (kill-buffer sc-electric-bufname)
  1575.     ))
  1576.  
  1577. ;; functions for electric reference mode
  1578. (defun sc-eref-show (index)
  1579.   "Show reference INDEX in `sc-rewrite-header-list'."
  1580.   (let ((msg "No %ing reference headers in list.")
  1581.     (last (length sc-rewrite-header-list)))
  1582.     (setq sc-eref-style
  1583.       (cond
  1584.        ((sc-valid-index-p index) index)
  1585.        ((< index 0)
  1586.         (if sc-electric-circular-p
  1587.         (1- last)
  1588.           (progn (error msg "preced") 0)))
  1589.        ((>= index last)
  1590.         (if sc-electric-circular-p
  1591.         0
  1592.           (progn (error msg "follow") (1- last))))
  1593.        ))
  1594.     (save-excursion
  1595.      (set-buffer sc-electric-bufname)
  1596.      (let ((buffer-read-only nil))
  1597.        (erase-buffer)
  1598.        (goto-char (point-min))
  1599.        (sc-eref-insert-selected)
  1600.        ;; now shrink the window to just contain the electric reference
  1601.        ;; header.
  1602.        (let ((hdrlines (count-lines (point-min) (point-max)))
  1603.          (winlines (1- (window-height))))
  1604.      (if (/= hdrlines winlines)
  1605.          (if (> hdrlines winlines)
  1606.          ;; we have to enlarge the window
  1607.          (enlarge-window (- hdrlines winlines))
  1608.            ;; we have to shrink the window
  1609.            (shrink-window (- winlines (max hdrlines window-min-height)))
  1610.            )))
  1611.        ))))
  1612.  
  1613. (defun sc-eref-next ()
  1614.   "Display next reference in other buffer."
  1615.   (interactive)
  1616.   (sc-eref-show (1+ sc-eref-style)))
  1617.  
  1618. (defun sc-eref-prev ()
  1619.   "Display previous reference in other buffer."
  1620.   (interactive)
  1621.   (sc-eref-show (1- sc-eref-style)))
  1622.  
  1623. (defun sc-eref-setn ()
  1624.   "Set reference header selected as preferred."
  1625.   (interactive)
  1626.   (setq sc-preferred-header-style sc-eref-style)
  1627.   (message "Preferred reference style set to header %d." sc-eref-style))
  1628.  
  1629. (defun sc-eref-goto (refnum)
  1630.   "Show reference style indexed by REFNUM.
  1631. If REFNUM is an invalid index, don't go to that reference and return
  1632. nil."
  1633.   (interactive "NGoto Reference: ")
  1634.   (if (sc-valid-index-p refnum)
  1635.       (sc-eref-show refnum)
  1636.     (error "Invalid reference: %d. (Range: [%d .. %d])"
  1637.        refnum 0 (1- (length sc-rewrite-header-list)))
  1638.     ))
  1639.  
  1640. (defun sc-eref-jump ()
  1641.   "Set reference header to preferred header."
  1642.   (interactive)
  1643.   (sc-eref-show sc-preferred-header-style))
  1644.  
  1645. (defun sc-eref-abort ()
  1646.   "Exit from electric reference mode without inserting reference."
  1647.   (interactive)
  1648.   (setq sc-eref-style nil)
  1649.   (exit-recursive-edit))
  1650.  
  1651. (defun sc-eref-exit ()
  1652.   "Exit from electric reference mode and insert selected reference."
  1653.   (interactive)
  1654.   (exit-recursive-edit))
  1655.  
  1656. (defun sc-insert-reference (arg)
  1657.   "Insert, at point, a reference header in the body of the reply.
  1658. Numeric ARG indicates which header style from `sc-rewrite-header-list'
  1659. to use when rewriting the header.  No supplied ARG indicates use of
  1660. `sc-preferred-header-style'.
  1661.  
  1662. With just `\\[universal-argument]', electric reference insert mode is
  1663. entered, regardless of the value of `sc-electric-references-p'.  See
  1664. `sc-electric-mode' for more information."
  1665.   (interactive "P")
  1666.   (if (consp arg)
  1667.       (sc-electric-mode)
  1668.     (let ((preference (or (sc-valid-index-p arg)
  1669.               (sc-valid-index-p sc-preferred-header-style)
  1670.               sc-preferred-header-style
  1671.               0)))
  1672.       (if sc-electric-references-p
  1673.       (sc-electric-mode preference)
  1674.     (sc-eref-insert-selected t)
  1675.     ))))
  1676.  
  1677.  
  1678. ;; ======================================================================
  1679. ;; variable toggling
  1680.  
  1681. (defun sc-raw-mode-toggle ()
  1682.   "Toggle, in one fell swoop, two important SC variables:
  1683. `sc-fixup-whitespace-p' and `sc-auto-fill-region-p'"
  1684.   (interactive)
  1685.   (setq sc-fixup-whitespace-p (not sc-fixup-whitespace-p)
  1686.     sc-auto-fill-region-p (not sc-auto-fill-region-p))
  1687.   (sc-set-mode-string)
  1688.   (set-buffer-modified-p (buffer-modified-p)))
  1689.  
  1690. (defun sc-toggle-var (variable)
  1691.   "Boolean toggle VARIABLE's value.
  1692. VARIABLE must be a bound symbol.  Nil values change to t, non-nil
  1693. values are changed to nil."
  1694.   (message "%s changed from %s to %s"
  1695.        variable (symbol-value variable)
  1696.        (set-variable variable (not (eval-expression variable))))
  1697.   (sc-set-mode-string))
  1698.  
  1699. (defun sc-set-variable (var)
  1700.   "Set the Supercite VARIABLE.
  1701. This function mimics `set-variable', except that the variable to set
  1702. is determined non-interactively.  The value is queried for in the
  1703. minibuffer exactly the same way that `set-variable' does it.
  1704.  
  1705. You can see the current value of the variable when the minibuffer is
  1706. querying you by typing `C-h'.  Note that the format is changed
  1707. slightly from that used by `set-variable' -- the current value is
  1708. printed just after the variable's name instead of at the bottom of the
  1709. help window."
  1710.   (let* ((minibuffer-help-form
  1711.       '(funcall myhelp))
  1712.      (myhelp
  1713.       (function
  1714.        (lambda ()
  1715.          (with-output-to-temp-buffer "*Help*"
  1716.            (prin1 var)
  1717.            (if (boundp var)
  1718.            (let ((print-length 20))
  1719.              (princ "\t(Current value: ")
  1720.              (prin1 (symbol-value var))
  1721.              (princ ")")))
  1722.            (princ "\n\nDocumentation:\n")
  1723.            (princ (substring (documentation-property
  1724.                   var
  1725.                   'variable-documentation)
  1726.                   1))
  1727.            nil)))))
  1728.     (set var (eval-minibuffer (format "Set %s to value: " var))))
  1729.   (sc-set-mode-string))
  1730.  
  1731. (defmacro sc-toggle-symbol (rootname)
  1732.   (list 'defun (intern (concat "sc-T-" rootname)) '()
  1733.     (list 'interactive)
  1734.     (list 'sc-toggle-var
  1735.           (list 'quote (intern (concat "sc-" rootname "-p"))))))
  1736.  
  1737. (defmacro sc-setvar-symbol (rootname)
  1738.   (list 'defun (intern (concat "sc-S-" rootname)) '()
  1739.     (list 'interactive)
  1740.     (list 'sc-set-variable
  1741.           (list 'quote (intern (concat "sc-" rootname))))))
  1742.  
  1743. (sc-toggle-symbol "confirm-always")
  1744. (sc-toggle-symbol "downcase")
  1745. (sc-toggle-symbol "electric-references")
  1746. (sc-toggle-symbol "auto-fill-region")
  1747. (sc-toggle-symbol "mail-nuke-blank-lines")
  1748. (sc-toggle-symbol "nested-citation")
  1749. (sc-toggle-symbol "electric-circular")
  1750. (sc-toggle-symbol "use-only-preferences")
  1751. (sc-toggle-symbol "fixup-whitespace")
  1752.  
  1753. (sc-setvar-symbol "preferred-attribution-list")
  1754. (sc-setvar-symbol "preferred-header-style")
  1755. (sc-setvar-symbol "mail-nuke-mail-headers")
  1756. (sc-setvar-symbol "mail-header-nuke-list")
  1757. (sc-setvar-symbol "cite-region-limit")
  1758.  
  1759. (defun sc-T-describe ()
  1760.   "
  1761.  
  1762. Supercite provides a number of key bindings which simplify the process
  1763. of setting or toggling certain variables controlling its operation.
  1764.  
  1765. Note on function names in this list: all functions of the form
  1766. `sc-S-<name>' actually call `sc-set-variable' on the corresponding
  1767. `sc-<name>' variable.  All functions of the form `sc-T-<name>' call
  1768. `sc-toggle-var' on the corresponding `sc-<name>-p' variable.
  1769.  
  1770. \\{sc-T-keymap}"
  1771.   (interactive)
  1772.   (describe-function 'sc-T-describe))
  1773.  
  1774. (defun sc-set-mode-string ()
  1775.   "Update the minor mode string to show state of Supercite."
  1776.   (setq sc-mode-string
  1777.     (concat " SC"
  1778.         (if (or sc-auto-fill-region-p
  1779.             sc-fixup-whitespace-p)
  1780.             ":" "")
  1781.         (if sc-auto-fill-region-p "f" "")
  1782.         (if sc-fixup-whitespace-p "w" "")
  1783.         )))
  1784.  
  1785.  
  1786. ;; ======================================================================
  1787. ;; published interface to mail and news readers
  1788.  
  1789. (defun sc-cite-original ()
  1790.   "Workhorse citing function which performs the initial citation.
  1791. This is callable from the various mail and news readers' reply
  1792. function according to the agreed upon standard.  See `\\[sc-describe]'
  1793. for more details.  `sc-cite-original' does not do any yanking of the
  1794. original message but it does require a few things:
  1795.  
  1796.      1) The reply buffer is the current buffer.
  1797.  
  1798.      2) The original message has been yanked and inserted into the
  1799.         reply buffer.
  1800.  
  1801.      3) Verbose mail headers from the original message have been
  1802.         inserted into the reply buffer directly before the text of the
  1803.         original message.
  1804.  
  1805.      4) Point is at the beginning of the verbose headers.
  1806.  
  1807.      5) Mark is at the end of the body of text to be cited.
  1808.  
  1809. For Emacs 19's, the region need not be active (and typically isn't
  1810. when this function is called.  Also, the hook `sc-pre-hook' is run
  1811. before, and `sc-post-hook' is run after the guts of this function."
  1812.   (run-hooks 'sc-pre-hook)
  1813.  
  1814.   ;; before we do anything, we want to insert the supercite keymap so
  1815.   ;; we can proceed from here
  1816.   (and sc-mode-map-prefix
  1817.        (local-set-key sc-mode-map-prefix sc-mode-map))
  1818.  
  1819.   ;; hack onto the minor mode alist, if it hasn't been done before,
  1820.   ;; then turn on the minor mode. also, set the minor mode string with
  1821.   ;; the values of fill and fixup whitespace variables
  1822.   (if (not (get 'minor-mode-alist 'sc-minor-mode))
  1823.       (progn
  1824.     (put 'minor-mode-alist 'sc-minor-mode 'sc-minor-mode)
  1825.     (setq minor-mode-alist
  1826.           (cons '(sc-minor-mode sc-mode-string) minor-mode-alist))
  1827.     ))
  1828.   (setq sc-minor-mode t)
  1829.   (sc-set-mode-string)
  1830.  
  1831.   (undo-boundary)
  1832.  
  1833.   ;; grab point and mark since the region is probably not active when
  1834.   ;; this function gets automatically called. we want point to be a
  1835.   ;; mark so any deleting before point works properly
  1836.   (let* ((zmacs-regions nil)        ; for Lemacs
  1837.      (mark-active t)        ; for FSFmacs
  1838.      (point (point-marker))
  1839.      (mark  (copy-marker (mark-marker))))
  1840.   
  1841.     ;; make sure point comes before mark, not all functions are
  1842.     ;; interactive "r"
  1843.     (if (< mark point)
  1844.     (let ((tmp point))
  1845.       (setq point mark
  1846.         mark tmp)))
  1847.  
  1848.     ;; first process mail headers, and populate sc-mail-info
  1849.     (sc-mail-process-headers point mark)
  1850.  
  1851.     ;; now get possible attributions
  1852.     (sc-attribs-chop-address (or (sc-mail-field "from")
  1853.                  (sc-mail-field "reply")
  1854.                  (sc-mail-field "reply-to")
  1855.                  (sc-mail-field "sender")))
  1856.     ;; select the attribution
  1857.     (sc-select-attribution)
  1858.  
  1859.     ;; cite the region, but first check the value of sc-cite-region-limit
  1860.     (let ((linecnt (count-lines point mark)))
  1861.       (and sc-cite-region-limit
  1862.        (if (or (not (numberp sc-cite-region-limit))
  1863.            (<= linecnt sc-cite-region-limit))
  1864.            (progn
  1865.          ;; cite the region and insert the header rewrite
  1866.          (sc-cite-region point mark)
  1867.          (goto-char point)
  1868.          (let ((sc-eref-style (or sc-preferred-header-style 0)))
  1869.            (if sc-electric-references-p
  1870.                (sc-electric-mode sc-eref-style)
  1871.              (sc-eref-insert-selected t))))
  1872.          (beep)
  1873.          (message
  1874.           "Region not cited. %d lines exceeds sc-cite-region-limit: %d"
  1875.           linecnt sc-cite-region-limit))))
  1876.  
  1877.     ;; finally, free the point-marker
  1878.     (set-marker point nil)
  1879.     (set-marker mark nil)
  1880.     )
  1881.   (run-hooks 'sc-post-hook)
  1882.   ;; post hook could have changed the variables
  1883.   (sc-set-mode-string))
  1884.  
  1885.  
  1886. ;; ======================================================================
  1887. ;; bug reporting and miscellaneous commands
  1888.  
  1889. (defun sc-open-line (arg)
  1890.   "Like `open-line', but insert the citation prefix at the front of the line.
  1891. With numeric ARG, inserts that many new lines."
  1892.   (interactive "p")
  1893.   (save-excursion
  1894.     (let ((start (point))
  1895.       (prefix (or (progn (beginning-of-line)
  1896.                  (if (looking-at (sc-cite-regexp))
  1897.                  (sc-submatch 0)))
  1898.               "")))
  1899.       (goto-char start)
  1900.       (open-line arg)
  1901.       (forward-line 1)
  1902.       (while (< 0 arg)
  1903.     (insert prefix)
  1904.     (forward-line 1)
  1905.     (setq arg (1- arg))
  1906.     ))))
  1907.  
  1908. (defun sc-insert-citation (arg)
  1909.   "Insert citation string at beginning of current line if not already cited.
  1910. With `\\[universal-argument]' insert citation even if line is already
  1911. cited."
  1912.   (interactive "P")
  1913.   (save-excursion
  1914.     (beginning-of-line)
  1915.     (if (or (not (looking-at (sc-cite-regexp)))
  1916.         (looking-at "^[ \t]*$")
  1917.         (consp arg))
  1918.     (insert (sc-mail-field "sc-citation"))
  1919.       (error "Line is already cited."))))
  1920.  
  1921. (defun sc-version (arg)
  1922.   "Echo the current version of Supercite in the minibuffer.
  1923. With \\[universal-argument] (universal-argument), or if run non-interactively,
  1924. inserts the version string in the current buffer instead."
  1925.   (interactive "P")
  1926.   (let ((verstr (format "Using Supercite.el %s" sc-version)))
  1927.     (if (or (consp arg)
  1928.         (not (interactive-p)))
  1929.     (insert "`sc-version' says: " verstr)
  1930.       (message verstr))))
  1931.  
  1932. (defun sc-describe ()
  1933.   "
  1934. Supercite is a package which provides a flexible mechanism for citing
  1935. email and news replies.  Please see the associated texinfo file for
  1936. more information."
  1937.   (interactive)
  1938.   (describe-function 'sc-describe))
  1939.  
  1940. (defun sc-submit-bug-report ()
  1941.   "Submit a bug report on Supercite via mail."
  1942.   (interactive)
  1943.   (require 'reporter)
  1944.   (and
  1945.    (y-or-n-p "Do you want to submit a report on Supercite? ")
  1946.    (reporter-submit-bug-report
  1947.     sc-help-address
  1948.     (concat "Supercite version " sc-version)
  1949.     (list
  1950.      'sc-attrib-selection-list
  1951.      'sc-auto-fill-region-p
  1952.      'sc-blank-lines-after-headers
  1953.      'sc-citation-leader
  1954.      'sc-citation-delimiter
  1955.      'sc-citation-separator
  1956.      'sc-citation-leader-regexp
  1957.      'sc-citation-root-regexp
  1958.      'sc-citation-nonnested-root-regexp
  1959.      'sc-citation-delimiter-regexp
  1960.      'sc-citation-separator-regexp
  1961.      'sc-cite-region-limit
  1962.      'sc-confirm-always-p
  1963.      'sc-default-attribution
  1964.      'sc-default-author-name
  1965.      'sc-downcase-p
  1966.      'sc-electric-circular-p
  1967.      'sc-electric-references-p
  1968.      'sc-fixup-whitespace-p
  1969.      'sc-mail-warn-if-non-rfc822-p
  1970.      'sc-mumble
  1971.      'sc-name-filter-alist
  1972.      'sc-nested-citation-p
  1973.      'sc-nuke-mail-headers
  1974.      'sc-nuke-mail-header-list
  1975.      'sc-preferred-attribution-list
  1976.      'sc-preferred-header-style
  1977.      'sc-reference-tag-string
  1978.      'sc-rewrite-header-list
  1979.      'sc-titlecue-regexp
  1980.      'sc-use-only-preference-p
  1981.      ))))
  1982.  
  1983.  
  1984. ;; useful stuff
  1985. (provide 'supercite)
  1986. (run-hooks 'sc-load-hook)
  1987.  
  1988. ;;; supercite.el ends here
  1989.